<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>vphy: xvphy_intr.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">vphy
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xvphy__intr_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xvphy_intr.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains functions related to <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> interrupt handling. </p>
<dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
<hr/>

1.0   als  10/19/15 Initial release.
1.4   gm   29/11/16 Added XVphy_CfgErrIntr for ERR_IRQ impl
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab0c6c186dbb5142d23a6a3b76148c37b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvphy__intr_8c.html#ab0c6c186dbb5142d23a6a3b76148c37b">XVphy_IntrEnable</a> (<a class="el" href="struct_x_vphy.html">XVphy</a> *InstancePtr, <a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a> Intr)</td></tr>
<tr class="memdesc:ab0c6c186dbb5142d23a6a3b76148c37b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables interrupts associated with the specified interrupt type.  <a href="#ab0c6c186dbb5142d23a6a3b76148c37b">More...</a><br /></td></tr>
<tr class="separator:ab0c6c186dbb5142d23a6a3b76148c37b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a854725cac309c3302a25dbc29927c9f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvphy__intr_8c.html#a854725cac309c3302a25dbc29927c9f8">XVphy_IntrDisable</a> (<a class="el" href="struct_x_vphy.html">XVphy</a> *InstancePtr, <a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a> Intr)</td></tr>
<tr class="memdesc:a854725cac309c3302a25dbc29927c9f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disabled interrupts associated with the specified interrupt type.  <a href="#a854725cac309c3302a25dbc29927c9f8">More...</a><br /></td></tr>
<tr class="separator:a854725cac309c3302a25dbc29927c9f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56237326dcb3ef7cb3b346f7bf561486"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvphy__intr_8c.html#a56237326dcb3ef7cb3b346f7bf561486">XVphy_SetIntrHandler</a> (<a class="el" href="struct_x_vphy.html">XVphy</a> *InstancePtr, <a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a> HandlerType, <a class="el" href="xvphy_8h.html#a21fe7ac2940a12aa24d265c30d02b1aa">XVphy_IntrHandler</a> CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:a56237326dcb3ef7cb3b346f7bf561486"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs a callback function for the specified handler type.  <a href="#a56237326dcb3ef7cb3b346f7bf561486">More...</a><br /></td></tr>
<tr class="separator:a56237326dcb3ef7cb3b346f7bf561486"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75e14bbc2dcc8eeeaaed26371ae1b34c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvphy__intr_8c.html#a75e14bbc2dcc8eeeaaed26371ae1b34c">XVphy_InterruptHandler</a> (<a class="el" href="struct_x_vphy.html">XVphy</a> *InstancePtr)</td></tr>
<tr class="memdesc:a75e14bbc2dcc8eeeaaed26371ae1b34c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> driver.  <a href="#a75e14bbc2dcc8eeeaaed26371ae1b34c">More...</a><br /></td></tr>
<tr class="separator:a75e14bbc2dcc8eeeaaed26371ae1b34c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a047421b414d103faf15418f136e1d107"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvphy__intr_8c.html#a047421b414d103faf15418f136e1d107">XVphy_CfgErrIntr</a> (<a class="el" href="struct_x_vphy.html">XVphy</a> *InstancePtr, <a class="el" href="xvphy_8h.html#a63f8585e9f30f40cf292b200922ea058">XVphy_ErrIrqType</a> ErrIrq, u8 Set)</td></tr>
<tr class="memdesc:a047421b414d103faf15418f136e1d107"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the error IRQ register based on the condition to generate an ERR_IRQ event.  <a href="#a047421b414d103faf15418f136e1d107">More...</a><br /></td></tr>
<tr class="separator:a047421b414d103faf15418f136e1d107"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a047421b414d103faf15418f136e1d107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a047421b414d103faf15418f136e1d107">&#9670;&nbsp;</a></span>XVphy_CfgErrIntr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVphy_CfgErrIntr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vphy.html">XVphy</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvphy_8h.html#a63f8585e9f30f40cf292b200922ea058">XVphy_ErrIrqType</a>&#160;</td>
          <td class="paramname"><em>ErrIrq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Set</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the error IRQ register based on the condition to generate an ERR_IRQ event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> instance. ErrIrq is the IRQ type as define in XVphy_ErrIrqType Set is the flag to set or clear the ErrIrq param</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vphy___config.html#a37ebb950e78d0d9bedc29b27ad6619d3">XVphy_Config::BaseAddr</a>, <a class="el" href="struct_x_vphy.html#a45ad21128fb62d2f120e92ae3488c32c">XVphy::Config</a>, and <a class="el" href="xvphy__hw_8h.html#a4efa6fb68e702bd91a3fb099d7ba0188">XVphy_ReadReg</a>.</p>

</div>
</div>
<a id="a75e14bbc2dcc8eeeaaed26371ae1b34c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75e14bbc2dcc8eeeaaed26371ae1b34c">&#9670;&nbsp;</a></span>XVphy_InterruptHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVphy_InterruptHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vphy.html">XVphy</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> driver. </p>
<p>It will detect what kind of interrupt has happened, and will invoke the appropriate callback function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vphy___config.html#a37ebb950e78d0d9bedc29b27ad6619d3">XVphy_Config::BaseAddr</a>, <a class="el" href="struct_x_vphy.html#a45ad21128fb62d2f120e92ae3488c32c">XVphy::Config</a>, <a class="el" href="struct_x_vphy.html#a350b0f93bf83f2b3178e46e11936aa7f">XVphy::IsReady</a>, and <a class="el" href="xvphy__hw_8h.html#a4efa6fb68e702bd91a3fb099d7ba0188">XVphy_ReadReg</a>.</p>

</div>
</div>
<a id="a854725cac309c3302a25dbc29927c9f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a854725cac309c3302a25dbc29927c9f8">&#9670;&nbsp;</a></span>XVphy_IntrDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVphy_IntrDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vphy.html">XVphy</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a>&#160;</td>
          <td class="paramname"><em>Intr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function disabled interrupts associated with the specified interrupt type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> instance. </td></tr>
    <tr><td class="paramname">Intr</td><td>is the interrupt type/mask to disable.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vphy___config.html#a37ebb950e78d0d9bedc29b27ad6619d3">XVphy_Config::BaseAddr</a>, <a class="el" href="struct_x_vphy.html#a45ad21128fb62d2f120e92ae3488c32c">XVphy::Config</a>, and <a class="el" href="xvphy__hw_8h.html#a4efa6fb68e702bd91a3fb099d7ba0188">XVphy_ReadReg</a>.</p>

</div>
</div>
<a id="ab0c6c186dbb5142d23a6a3b76148c37b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0c6c186dbb5142d23a6a3b76148c37b">&#9670;&nbsp;</a></span>XVphy_IntrEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVphy_IntrEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vphy.html">XVphy</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a>&#160;</td>
          <td class="paramname"><em>Intr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables interrupts associated with the specified interrupt type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_vphy.html" title="The XVphy driver instance data. ">XVphy</a> instance. </td></tr>
    <tr><td class="paramname">Intr</td><td>is the interrupt type/mask to enable.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vphy___config.html#a37ebb950e78d0d9bedc29b27ad6619d3">XVphy_Config::BaseAddr</a>, <a class="el" href="struct_x_vphy.html#a45ad21128fb62d2f120e92ae3488c32c">XVphy::Config</a>, and <a class="el" href="xvphy__hw_8h.html#a4efa6fb68e702bd91a3fb099d7ba0188">XVphy_ReadReg</a>.</p>

</div>
</div>
<a id="a56237326dcb3ef7cb3b346f7bf561486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56237326dcb3ef7cb3b346f7bf561486">&#9670;&nbsp;</a></span>XVphy_SetIntrHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVphy_SetIntrHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vphy.html">XVphy</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvphy_8h.html#a87369c0a51fcd69621ccbbd44b64b470">XVphy_IntrHandlerType</a>&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvphy_8h.html#a21fe7ac2940a12aa24d265c30d02b1aa">XVphy_IntrHandler</a>&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs a callback function for the specified handler type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVPhy instance. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>is the interrupt handler type which specifies which interrupt event to attach the callback for. </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address to the callback function. </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is the user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
